1 /*
2 * Scope: a generic MVC framework.
3 * Copyright (c) 2000-2002, The Scope team
4 * All rights reserved.
5 *
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * Neither the name "Scope" nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 *
36 * $Id: UIStrings.java,v 1.6 2002/09/05 15:41:46 ludovicc Exp $
37 */
38 package org.scopemvc.util;
39
40
41 import java.util.MissingResourceException;
42 import java.util.ResourceBundle;
43 import org.apache.commons.logging.Log;
44 import org.apache.commons.logging.LogFactory;
45
46 /***
47 * <P>
48 *
49 * Uses a ResourceBundle as a dictionary mapping IDs against user-readable
50 * Strings that can be presented on the UI. A custom resource bundle should be
51 * provided, with a call to setPropertiesName during application initialisation.
52 * </P>
53 *
54 * @author <A HREF="mailto:smeyfroi@users.sourceforge.net">Steve Meyfroidt</A>
55 * @created 05 September 2002
56 * @version $Revision: 1.6 $ $Date: 2002/09/05 15:41:46 $
57 */
58 public final class UIStrings {
59
60 private final static Log LOG = LogFactory.getLog(UIStrings.class);
61
62 private static ResourceBundle properties;
63
64 private static String propertiesName;
65
66
67 private UIStrings() { }
68
69
70 /***
71 * TODO: document the method
72 *
73 * @param inKey TODO: Describe the Parameter
74 * @return TODO: Describe the Return Value
75 */
76 public static String get(String inKey) {
77 if (LOG.isDebugEnabled()) {
78 LOG.debug("get: " + inKey);
79 }
80
81 if (getProperties() == null) {
82 if (inKey == null) {
83 return "";
84 }
85 return inKey;
86 // missing resource!
87 }
88 try {
89 if (LOG.isDebugEnabled()) {
90 LOG.debug("get: " + inKey);
91 }
92 String result = getProperties().getString(inKey);
93 if (LOG.isDebugEnabled()) {
94 LOG.debug("get: " + result);
95 }
96 if (Debug.ON) {
97 Debug.assertTrue(result != null);
98 }
99 return result;
100 } catch (Throwable e) {
101 if (inKey == null) {
102 return "";
103 }
104 return inKey;
105 }
106 }
107
108
109 /***
110 * Sets the properties name
111 *
112 * @param inName The new propertiesName value
113 */
114 public static void setPropertiesName(String inName) {
115 if (inName == null) {
116 throw new IllegalArgumentException("Can't set properties name to null");
117 }
118 propertiesName = inName;
119 properties = null;
120 // force reload
121 }
122
123
124 private static ResourceBundle getProperties() {
125 if (propertiesName == null) {
126 return null;
127 }
128 if (properties == null) {
129 try {
130 properties = ResourceBundle.getBundle(propertiesName);
131 } catch (MissingResourceException e) {
132 LOG.error("getProperties: " + propertiesName, e);
133 if (Debug.ON) {
134 Debug.assertTrue(1 == 0, "Missing resources: " + propertiesName);
135 }
136 }
137 }
138 return properties;
139 }
140 }
141
This page was automatically generated by Maven